[PR #8216/a5b2b5ce backport][stable-8] Add support for docker-v2 protocol in Keycloak modules #8239
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
![patchback[bot]](https://avatars.githubusercontent.com/in/21488?s=60&v=4){kind=small}
* Add support for docker-v2 protocol in Keycloak modules * use dash instead of underscore for the docker-v2 * Update documentation * Add changelog fragment * fix missing whitespace around operator * Update changelogs/fragments/8215-add-docker-v2-protocol.yml Update changelog fragment to reviewers suggestion, add refrence to issue and pull request Co-authored-by: Felix Fontein <[email protected]> * Add documentation about adding docker-v2 value in community general 8.6.0 --------- Co-authored-by: Felix Fontein <[email protected]> (cherry picked from commit a5b2b5c)
ansibullbot
added
backport
feature
felixfontein
deleted the
patchback/backports/stable-8/a5b2b5ce8ca879a49df69a5fd997f74dd5139c47/pr-8216
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a backport of PR #8216 as merged into main (a5b2b5c).
SUMMARY
This pull request introduces the addition of the "docker-v2" protocol support to the
keycloak_client,keycloak_clientscope, andkeycloak_clienttemplatemodules within the community.general collection. The "docker-v2" protocol is a valid and supported option in Keycloak, which is crucial for configurations involving Docker registry authentication, among others. Fixes #8215.ISSUE TYPE
COMPONENT NAME
keycloak_clientkeycloak_clientscopekeycloak_clienttemplateADDITIONAL INFORMATION
I have enhanced the
protocolparameter across thekeycloak_client,keycloak_clientscope, andkeycloak_clienttemplatemodules to include the "docker-v2" option. It's important to note that the existing protocol choices varied across different modules — some were limited to['openid-connect', 'saml'], while others used Python constants to define the choices. I've respected the existing structure and conventions in each module, only extending them to include "docker-v2".For instance, if a module's protocol choices were previously defined as:
I have updated this to
And similarly, for modules using Python constants to define protocol choices, I've appended "docker-v2" to the existing list without altering the existing structure.
The documentation for each affected module has been updated to include "docker-v2" as a valid protocol option.
The modifications were tested to confirm that the "docker-v2" protocol is recognized and behaves as expected across the updated modules. I encourage further testing by the community to validate these changes across various usage scenarios.
I have not verified the potential error message from the Keycloak API when this option is used when the keycloak server has not activated the docker-v2 protocol, (disabled by default and enabled by running
bin/standalone.sh|bat -Dkeycloak.profile.feature.docker=enabledstarting the service, see (https://www.keycloak.org/server/features).